macroable

Macroable

Extend class prototype in style 😎

Base class for exposing external API to extend the class prototype in a more declarative way.

Traditional approach

class Foo {}
module.exports = Foo

Someone can extend it follows.

const Foo = require('./Foo')
Foo.prototype.greet = function () {
  return 'Hello!'
}

// or add getter as follow
Object.defineProperty(Foo.prototype, 'username', {
  get: function () {
    return 'virk'
  }
})

Using macroable

const { Macroable } from 'macroable'

class Foo extends Macroable {
}

Foo.macros = {}
Foo.getters = {}

module.exports = Foo

const Foo = require('./Foo')

Foo.macro('greet', function () {
  return 'Hello!'
})

Foo.getter('username', function () {
  return 'virk'
})

You can see the API is simpler and less verbose. However, there are couple of extra benefits of using Macroable.

Defining singleton getters

Singleton getters are evaluated only once and then cached value is returned.

Foo.getter('baseUrl', function () {
  return lazilyEvaluateAndReturnUrl()
}, true) 👈

Hydrating the class

Using the hydrate method, you can remove macros and getters added on a given class.

Foo.macro('greet', function (name) {
  return `Hello ${name}!`
})

Foo.getter('username', function () {
  return 'virk'
})

Foo.hydrate()  👈
Foo.greet // undefined
Foo.username // undefined